Additional features settings

IN THIS PAGE

Login Container
Password Reset Container
Password Reset Email Message Customization
New Password Container
New Account Container

Description

Settings for configuring Password Reset and Account Creation in a Login UX.

Discussion

If either the Allow password reset property or the Allow create account property is checked, the Additional features settings property is shown.

When you click the smart field for the Additional features settings property, the following dialog is shown when you can configure various aspects of the password reset and create account features.

Login Container

The Login Container is the container in the UX that contains the login controls. The settings in this section are used to configure the Login container.

Property: Description
Container Id: The ID of the Container control that contains the Login controls in the UX. Defaults to "CONTAINER_LOGIN".

Password Reset Container

If Allow password reset is enabled, the Password Reset Container settings are exposed. These settings define the container, controls, and messages to the user during the password reset process.

Property: Description
Container Id: The ID of the Container control that contains the Password Reset controls in the UX. Defaults to "CONTAINER_RESETPASSWORD".
Message Id: The ID of the DIV or HTML element where the Password Reset messages are shown. Defaults to "PASSWORDRESET".
Id email control: The ID of the control where the user enters their email address. This address is the address where the reset password email is sent. Defaults to "userid_resetpassword".
Id User id control: The ID of the control where the user enters their user name. The user's email address is looked up in the extended user information table. The reset password email is sent to the address found in the table. Defaults to "useridValue_resetpassword".
Initial message: The initial message shown when the Password Reset Container is displayed and the user is prompted to enter an email address. Defaults to "Enter your e-mail address, then click the Reset Password button".
Initial message (Value mode): The initial message shown when the Password Reset Container is displayed and the user is prompted to enter their user name. Defaults to "Enter your User id, then click the Reset Password button. An e-mail will be sent to the email address associated with your User id.".
Blank email address message: Error message shown when the user clicks the button to reset their password but did not provide their email address. Defaults to "You have not specified your e-mail address".
Blank user id message: Error message shown when the user clicks the button to reset their password but did not provide their user name. Defaults to "Please enter your User Id".
Sending email message: A wait message shown while the email is processed and sent. Defaults to "Sending the Password Reset email. Please wait...".
Email sent message: Message shown to the user after the reset password email has been sent. This message is used if the user provided an email address for password reset. The message informs the user what they need to do next to complete the reset password process. Defaults to "Check your email for your password reset email message".
Email sent message (Value mode): Message shown to the user after the reset password email has been sent. This message is used if the user provided their user name for password reset. The message informs the user what they need to do next to complete the reset password process. Defaults to "Check your email. An email was sent to the email address associated with this user id.".

Password Reset Email Message Customization

Property

Description

Email account

Defines the method used to send the reset password email. You can either use the built-in email client or your own email provider.

Email Account Type: Description
<System>: Default value. The email sis sent using the built-in email method.
<UseProjectSettings>: The email is sent using the email configuration defined in Project Properties.

Email message body

The body of the password reset email sent if the user resets their password using their email address. The email must include the {link} placeholder, which is the URL the user must visit to reset their password. Defaults to "You have submitted a password change request. Click <a href="{link}">here</a> to reset your password.".

Email message body (Reset token method)

The body of the password reset email sent if the user resets their password using their user name. The email must include the {link} placeholder, which is the URL the user must visit to reset their password. Defaults to "You have submitted a password change request. Here is your reset token {token}. You will need to enter this token in the dialog where you specify your new password.".

Email message subject

The email subject for the password reset email. Defaults to "Password Reset".

Email message from alias

The name of the person, service, or system sending the email. The name is shown in the from field of the password reset email. Defaults to "Admin".

Reset token duration (minutes)

The length of time in minutes the reset password token is valid. The token is sent to the user in the password reset email. Defaults to "60".

New Password Container

Property

Description

Container Id

The container that contains the controls for resetting the user's password. The container is shown when the user visits the component using the password reset link. Defaults to "CONTAINER_NEWPASSWORD".

Message Id

The ID of a DIV or HTML element where messages are displayed in the new password container. Defaults to "NEWPASSWORD".

Initial message

The message shown when the container is first shown. The portion of the message enclosed in curly braces {} is only shown to the user if the After login behavior is set to "FocusPanelCard" and the application is a Cordova app. Defaults to "Enter your new password, {(and the reset token from the Reset Password email)}, then press the Reset Password button.".

New password control

Defaults to "password_new".

Reset token control

Defaults to "resettoken".

New password confirmation control

Defaults to "password_confirmation_new".

Password reset success message

Defaults to "Password was reset".

Password reset failure message

Defaults to "Password was <b>not</b> reset".

Token invalid/expired message

Defaults to "The reset token has expired. Please request a new token.".

Password validation function

The name of a JavaScript function to call to validate the password entered by the user. The function takes the password as an argument and should return a string. If the password is valid, the returned string should be blank. If the password is invalid, the function should return an error message to display to the user. The error message should explain why the password is invalid. The message can include HTML markup to format the message.

For Example:

var jsValidPassword = function (pw) {
    var error = [];
    // Validate lowercase letters
    var lowerCaseLetters = /[a-z]/g;
    if(pw.match(lowerCaseLetters) == null) {
        error.push("<li>Password must contain at least one lower case letter a-z.</li>");
    }

    // Validate capital letters
    var upperCaseLetters = /[A-Z]/g;
    if(pw.match(upperCaseLetters) == null) {
        error.push("<li>Password must contain at least one upper case letter A-Z.</li>");
    }

    // Validate numbers
    var numbers = /[0-9]/g;
    if(pw.match(numbers) == null) {
        error.push("<li>Password must contain at least one number 0-9.</li>");
    }

    // Validate length
    if(pw.length < 8) {
        error.push("<li>Password must be at least 8 characters in length.</li>");
    }

    if (error.length > 0) {
        error = "<p>Invalid Password:</p><ul>" + error.join("") + "</ul>";
    } else {
        error = "";
    }

    return error;
};

Userid validation function

The name of a JavaScript function to call to validate the user id entered by the user. The function takes the user id as an argument and should return a string. If the user id is valid, the function should return a blank string. If the password is invalid, the function should return an error message.

The error message should explain why the user id is invalid. The message can include HTML markup to format the message.

var jsValidUser = function (usr) {
    if (usr.length < 10) {
        return "User id must be at least 10 characters in length.";
    }
    
    return "";
}

New Account Container

Property

Description

Container Id

Defaults to "CONTAINER_NEWACCOUNT".

Message Id

Defaults to "NEWACCOUNT".

Initial message

Defaults to "Specify the credentials for your new account, then click the 'Create Account' button.".

Userid

Defaults to "userid_newaccount".

Password

Defaults to "password_newaccount".

Password confirmation

Defaults to "password_confirmation_newaccount".

Password validation function

The error message should explain why the password is invalid. The message can include HTML markup to format the message.

See the Password validation function in the New Password Container settings above for an example.

Missing Userid message

Defaults to "Please specify the User Id".

Invalid Userid message

Defaults to "UserId is not a valid e-mail address".

Missing password message

Defaults to "Please specify the password".

Password confirmation does not match message

Defaults to "Passwords do not match".

Creating new account message

Defaults to "Creating new account. Please wait...".

Success message

Defaults to "New account was created.".

Error message

Defaults to "New account was not created.".

Get extended user information when creating new account

Defaults to "No".

Extended user information container Id

Defaults to "CONTAINER_EXTENDEDUSERINFO".

Extended user information message id

Defaults to "EXTENDEDUSERINFO".

Extended user information container - initial message

Defaults to "Specify additional user information".